package com.gssbh.framework.toolkit.web.constant;


/***
 * API 前缀和后缀常量
 * 采用约定大于规则的思想,只允许如下API前缀, 后缀根据业务需要进修添加
 */
public interface ApiPathConstants {

    /**
     * api 前缀
     */
    String API_PREFIX = "/api";

    /**
     * 学生模块操作API的前缀
     */
    String STUDENT_API_PREFIX = "/api/student";


    /**
     * 老师模块操作API的前缀
     */
    String TEACHER_API_PREFIX = "/api/teacher";

    /**
     * 家长模块操作API的前缀
     */
    String PARENTS_API_PREFIX = "/api/parents";

    /**
     * 学校模块操作API的前缀
     */
    String SCHOOL_API_PREFIX = "/api/school";

    /**
     * 教育局模块操作API的前缀
     */
    String EDUCATION_API_PREFIX = "/api/edu";

    /**
     * 系统相关模块操作API的前缀
     */
    String SYSTEM_API_PREFIX = "/api/system";


    /***
     * 采用约定大于规则的模式，如果API后缀为allow,则认证用户可访问
     */
    String ALLOW_API_SUFFIX = "/allow";

    /***
     * 采用约定大于规则的模式，如果API后缀为grant,则用户必须获得授权才能访问
     */
    String GRANT_API_SUFFIX = "/grant";

    /***
     * 采用约定大于规则的模式，如果API为visible,则所有用可访问
     */
    String VISIBLE_API_SUFFIX = "/visible";
}

